Improve docstrings #158

gipert · 2025-09-27T10:57:34Z

Summary

Converted the build_processing_chain documentation to a YAML-focused example and corrected the processor reference text.
Added module-level docstrings throughout the processor package to describe each module and align YAML configuration examples (e.g., baseline subtraction and convolution filters).
Clarified processor docstrings to fix formatting and semantics, including machine-learning activations and conditional selection helpers.

Testing

pre-commit run --all-files
make

https://chatgpt.com/codex/tasks/task_e_68d7b6502b7c8330ac88bdb6f6a4a494

iguinn · 2025-10-02T17:32:36Z

For a lot of the YAML output, I'm not sure I'd say it's helping with clarity. The problem is it really blows up the number of lines by turning [arg1, arg2, arg2] into

- arg1
- arg2
- arg3

Also some of the module descriptions aren't accurate (for example the histograming is for building a histogram of samples; the moving window average is for performing a moving window average convolution of the waveform, etc.)

gipert · 2025-10-02T21:38:08Z

yeah the AI is not perfect. we can ask it to turn some of the lists to inline. could you give suggestions on the docstrings?

gipert · 2025-11-21T19:32:23Z

@iguinn fine to merge this?

src/dspeed/processors/moving_windows.py

src/dspeed/processors/multi_a_filter.py

src/dspeed/processors/multi_t_filter.py

src/dspeed/processors/optimize.py

src/dspeed/processors/peak_snr_threshold.py

src/dspeed/processors/presum.py

src/dspeed/processors/recursive_filter.py

src/dspeed/processors/round_to_nearest.py

src/dspeed/processors/saturation.py

src/dspeed/processors/tf_model.py

gipert added the codex label Sep 27, 2025 — with ChatGPT Codex Connector

gipert requested a review from iguinn September 27, 2025 10:58

gipert changed the title ~~Restore JSON mention in processing chain documentation~~ Improve docstrings Sep 27, 2025

gipert and others added 2 commits November 21, 2025 20:30

Restore JSON reference in processing chain docs

d4a5170

docstrings: wrap some yaml arrays

fb6883f

gipert force-pushed the codex/fix-docstrings-and-convert-json-to-yaml branch from 7d882e8 to fb6883f Compare November 21, 2025 19:32